M

Document.NewFlexDuct

Description:
Adds a new flexible duct into the document, using a connector, point array and duct type.

Remarks:
If the connector is a fitting or equipment connector of the correct domain, and if the connector's direction matches the direction of the flexible duct to be created, the connectors will be automatically connected. A transition fitting will be added at the connector(s) if necessary. If the connector's type, domain, does not match the one of the input connector, no connection will be established.

Overloads (3):

NewFlexDuct

NewFlexDuct(Connector,Connector,FlexDuctType)

NewFlexDuct(Connector,IList[XYZ],FlexDuctType)

NewFlexDuct(IList[XYZ],FlexDuctType)

public FlexDuct NewFlexDuct(
	Connector connector,
	IList<XYZ> points,
	FlexDuctType ductType
)

Public Function NewFlexDuct ( 
	connector As Connector,
	points As IList(Of XYZ),
	ductType As FlexDuctType
) As FlexDuct

public:
FlexDuct^ NewFlexDuct(
	Connector^ connector, 
	IList<XYZ^>^ points, 
	FlexDuctType^ ductType
)

member NewFlexDuct : 
        connector : Connector * 
        points : IList<XYZ> * 
        ductType : FlexDuctType -> FlexDuct

Connector

connector

The connector to be connected to the duct, including the end points.
IList<XYZ>

points

The point array indicating the path of the flexible duct.
FlexDuctType

ductType

The type of the flexible duct.

Return Value FlexDuct If creation was successful then a new flexible duct is returned, otherwise an exception with failure information will be thrown.

ArgumentNullException

Thrown when the input argument connector or points is.
InvalidOperationException

Thrown when the flexible duct cannot be created or regenerate fails.
ArgumentException

Thrown if the flexible duct type does not exist in the given document.